<!DOCTYPE html>
<html lang="en-US">
<head>
    <meta charset="UTF-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="language" content="en" />
        <link href="./assets/ffd55088/css/bootstrap.css" rel="stylesheet">
<link href="./assets/5cf9384a/solarized_light.css" rel="stylesheet">
<link href="./assets/6c54116e/style.css" rel="stylesheet">
<script src="./assets/a44cef0f/jquery.js"></script>
<script src="./assets/ffd55088/js/bootstrap.js"></script>
<script src="./assets/8ac4e28a/jssearch.js"></script>    <title>The Definitive Guide to Yii 2.0</title>
</head>
<body>

<div class="wrap">
    <nav id="w263" class="navbar-inverse navbar-fixed-top navbar" role="navigation"><div class="navbar-header"><button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#w263-collapse"><span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span></button><a class="navbar-brand" href="./index.html">The Definitive Guide to Yii 2.0</a></div><div id="w263-collapse" class="collapse navbar-collapse"><ul id="w264" class="navbar-nav nav"><li><a href="./index.html">Class reference</a></li>
<li class="dropdown"><a class="dropdown-toggle" href="#" data-toggle="dropdown">Extensions <b class="caret"></b></a><ul id="w265" class="dropdown-menu"><li><a href="./ext-apidoc-index.html" tabindex="-1">apidoc</a></li>
<li><a href="./ext-authclient-index.html" tabindex="-1">authclient</a></li>
<li><a href="./ext-bootstrap-index.html" tabindex="-1">bootstrap</a></li>
<li><a href="./ext-codeception-index.html" tabindex="-1">codeception</a></li>
<li><a href="./ext-debug-index.html" tabindex="-1">debug</a></li>
<li><a href="./ext-elasticsearch-index.html" tabindex="-1">elasticsearch</a></li>
<li><a href="./ext-faker-index.html" tabindex="-1">faker</a></li>
<li><a href="./ext-gii-index.html" tabindex="-1">gii</a></li>
<li><a href="./ext-imagine-index.html" tabindex="-1">imagine</a></li>
<li><a href="./ext-jui-index.html" tabindex="-1">jui</a></li>
<li><a href="./ext-mongodb-index.html" tabindex="-1">mongodb</a></li>
<li><a href="./ext-redis-index.html" tabindex="-1">redis</a></li>
<li><a href="./ext-smarty-index.html" tabindex="-1">smarty</a></li>
<li><a href="./ext-sphinx-index.html" tabindex="-1">sphinx</a></li>
<li><a href="./ext-swiftmailer-index.html" tabindex="-1">swiftmailer</a></li>
<li><a href="./ext-twig-index.html" tabindex="-1">twig</a></li></ul></li>
<li><a href="./guide-README.html">Guide</a></li></ul><div class="navbar-form navbar-left" role="search">
  <div class="form-group">
    <input id="searchbox" type="text" class="form-control" placeholder="Search">
  </div>
</div>
</div></nav>
    <div id="search-resultbox" style="display: none;" class="modal-content">
        <ul id="search-results">
        </ul>
    </div>

    
<div class="row">
    <div class="col-md-2">
                <div id="navigation" class="list-group"><a class="list-group-item" href="#navigation-247" data-toggle="collapse" data-parent="#navigation">Introduction <b class="caret"></b></a><div id="navigation-247" class="submenu panel-collapse collapse"><a class="list-group-item" href="./guide-intro-yii.html">About Yii</a>
<a class="list-group-item" href="./guide-intro-upgrade-from-v1.html">Upgrading from Version 1.1</a></div>
<a class="list-group-item" href="#navigation-248" data-toggle="collapse" data-parent="#navigation">Getting Started <b class="caret"></b></a><div id="navigation-248" class="submenu panel-collapse collapse"><a class="list-group-item" href="./guide-start-installation.html">Installing Yii</a>
<a class="list-group-item" href="./guide-start-workflow.html">Running Applications</a>
<a class="list-group-item" href="./guide-start-hello.html">Saying Hello</a>
<a class="list-group-item" href="./guide-start-forms.html">Working with Forms</a>
<a class="list-group-item" href="./guide-start-databases.html">Working with Databases</a>
<a class="list-group-item" href="./guide-start-gii.html">Generating Code with Gii</a>
<a class="list-group-item" href="./guide-start-looking-ahead.html">Looking Ahead</a></div>
<a class="list-group-item" href="#navigation-249" data-toggle="collapse" data-parent="#navigation">Application Structure <b class="caret"></b></a><div id="navigation-249" class="submenu panel-collapse collapse"><a class="list-group-item" href="./guide-structure-overview.html">Overview</a>
<a class="list-group-item" href="./guide-structure-entry-scripts.html">Entry Scripts</a>
<a class="list-group-item" href="./guide-structure-applications.html">Applications</a>
<a class="list-group-item" href="./guide-structure-application-components.html">Application Components</a>
<a class="list-group-item" href="./guide-structure-controllers.html">Controllers</a>
<a class="list-group-item" href="./guide-structure-models.html">Models</a>
<a class="list-group-item" href="./guide-structure-views.html">Views</a>
<a class="list-group-item" href="./guide-structure-modules.html">Modules</a>
<a class="list-group-item" href="./guide-structure-filters.html">Filters</a>
<a class="list-group-item" href="./guide-structure-widgets.html">Widgets</a>
<a class="list-group-item" href="./guide-structure-assets.html">Assets</a>
<a class="list-group-item" href="./guide-structure-extensions.html">Extensions</a></div>
<a class="list-group-item" href="#navigation-250" data-toggle="collapse" data-parent="#navigation">Handling Requests <b class="caret"></b></a><div id="navigation-250" class="submenu panel-collapse collapse"><a class="list-group-item" href="./guide-runtime-overview.html">Overview</a>
<a class="list-group-item" href="./guide-runtime-bootstrapping.html">Bootstrapping</a>
<a class="list-group-item" href="./guide-runtime-routing.html">Routing and URL Creation</a>
<a class="list-group-item" href="./guide-runtime-requests.html">Requests</a>
<a class="list-group-item" href="./guide-runtime-responses.html">Responses</a>
<a class="list-group-item" href="./guide-runtime-sessions-cookies.html">Sessions and Cookies</a>
<a class="list-group-item" href="./guide-runtime-handling-errors.html">Handling Errors</a>
<a class="list-group-item" href="./guide-runtime-logging.html">Logging</a></div>
<a class="list-group-item" href="#navigation-251" data-toggle="collapse" data-parent="#navigation">Key Concepts <b class="caret"></b></a><div id="navigation-251" class="submenu panel-collapse collapse"><a class="list-group-item" href="./guide-concept-components.html">Components</a>
<a class="list-group-item" href="./guide-concept-properties.html">Properties</a>
<a class="list-group-item" href="./guide-concept-events.html">Events</a>
<a class="list-group-item" href="./guide-concept-behaviors.html">Behaviors</a>
<a class="list-group-item" href="./guide-concept-configurations.html">Configurations</a>
<a class="list-group-item" href="./guide-concept-aliases.html">Aliases</a>
<a class="list-group-item" href="./guide-concept-autoloading.html">Class Autoloading</a>
<a class="list-group-item" href="./guide-concept-service-locator.html">Service Locator</a>
<a class="list-group-item" href="./guide-concept-di-container.html">Dependency Injection Container</a></div>
<a class="list-group-item" href="#navigation-252" data-toggle="collapse" data-parent="#navigation">Working with Databases <b class="caret"></b></a><div id="navigation-252" class="submenu panel-collapse collapse"><a class="list-group-item" href="./guide-db-dao.html">Data Access Objects</a>
<a class="list-group-item" href="./guide-db-query-builder.html">Query Builder</a>
<a class="list-group-item" href="./guide-db-active-record.html">Active Record</a>
<a class="list-group-item" href="./guide-db-migrations.html">Migrations</a>
<a class="list-group-item" href="https://github.com/yiisoft/yii2-sphinx/blob/master/docs/guide/README.md">Sphinx</a>
<a class="list-group-item" href="https://github.com/yiisoft/yii2-redis/blob/master/docs/guide/README.md">Redis</a>
<a class="list-group-item" href="https://github.com/yiisoft/yii2-mongodb/blob/master/docs/guide/README.md">MongoDB</a>
<a class="list-group-item" href="https://github.com/yiisoft/yii2-elasticsearch/blob/master/docs/guide/README.md">ElasticSearch</a></div>
<a class="list-group-item" href="#navigation-253" data-toggle="collapse" data-parent="#navigation">Getting Data from Users <b class="caret"></b></a><div id="navigation-253" class="submenu panel-collapse collapse"><a class="list-group-item" href="./guide-input-forms.html">Creating Forms</a>
<a class="list-group-item" href="./guide-input-validation.html">Validating Input</a>
<a class="list-group-item" href="./guide-input-file-upload.html">Uploading Files</a>
<a class="list-group-item" href="./guide-input-tabular-input.html">Collecting Tabular Input</a>
<a class="list-group-item" href="./guide-input-multiple-models.html">Getting Data for Multiple Models</a></div>
<a class="list-group-item" href="#navigation-254" data-toggle="collapse" data-parent="#navigation">Displaying Data <b class="caret"></b></a><div id="navigation-254" class="submenu panel-collapse collapse"><a class="list-group-item" href="./guide-output-formatting.html">Data Formatting</a>
<a class="list-group-item" href="./guide-output-pagination.html">Pagination</a>
<a class="list-group-item" href="./guide-output-sorting.html">Sorting</a>
<a class="list-group-item" href="./guide-output-data-providers.html">Data Providers</a>
<a class="list-group-item" href="./guide-output-data-widgets.html">Data Widgets</a>
<a class="list-group-item" href="./guide-output-client-scripts.html">Working with Client Scripts</a>
<a class="list-group-item" href="./guide-output-theming.html">Theming</a></div>
<a class="list-group-item" href="#navigation-255" data-toggle="collapse" data-parent="#navigation">Security <b class="caret"></b></a><div id="navigation-255" class="submenu panel-collapse collapse"><a class="list-group-item" href="./guide-security-overview.html">Overview</a>
<a class="list-group-item" href="./guide-security-authentication.html">Authentication</a>
<a class="list-group-item" href="./guide-security-authorization.html">Authorization</a>
<a class="list-group-item" href="./guide-security-passwords.html">Working with Passwords</a>
<a class="list-group-item" href="./guide-security-cryptography.html">Cryptography</a>
<a class="list-group-item" href="./guide-structure-views.html#security">Views security</a>
<a class="list-group-item" href="https://github.com/yiisoft/yii2-authclient/blob/master/docs/guide/README.md">Auth Clients</a>
<a class="list-group-item" href="./guide-security-best-practices.html">Best Practices</a></div>
<a class="list-group-item" href="#navigation-256" data-toggle="collapse" data-parent="#navigation">Caching <b class="caret"></b></a><div id="navigation-256" class="submenu panel-collapse collapse"><a class="list-group-item" href="./guide-caching-overview.html">Overview</a>
<a class="list-group-item" href="./guide-caching-data.html">Data Caching</a>
<a class="list-group-item" href="./guide-caching-fragment.html">Fragment Caching</a>
<a class="list-group-item" href="./guide-caching-page.html">Page Caching</a>
<a class="list-group-item" href="./guide-caching-http.html">HTTP Caching</a></div>
<a class="list-group-item" href="#navigation-257" data-toggle="collapse" data-parent="#navigation">RESTful Web Services <b class="caret"></b></a><div id="navigation-257" class="submenu panel-collapse collapse"><a class="list-group-item" href="./guide-rest-quick-start.html">Quick Start</a>
<a class="list-group-item" href="./guide-rest-resources.html">Resources</a>
<a class="list-group-item" href="./guide-rest-controllers.html">Controllers</a>
<a class="list-group-item" href="./guide-rest-routing.html">Routing</a>
<a class="list-group-item" href="./guide-rest-response-formatting.html">Response Formatting</a>
<a class="list-group-item" href="./guide-rest-authentication.html">Authentication</a>
<a class="list-group-item" href="./guide-rest-rate-limiting.html">Rate Limiting</a>
<a class="list-group-item" href="./guide-rest-versioning.html">Versioning</a>
<a class="list-group-item" href="./guide-rest-error-handling.html">Error Handling</a></div>
<a class="list-group-item" href="#navigation-258" data-toggle="collapse" data-parent="#navigation">Development Tools <b class="caret"></b></a><div id="navigation-258" class="submenu panel-collapse collapse"><a class="list-group-item" href="https://github.com/yiisoft/yii2-debug/blob/master/docs/guide/README.md">Debug Toolbar and Debugger</a>
<a class="list-group-item" href="https://github.com/yiisoft/yii2-gii/blob/master/docs/guide/README.md">Generating Code using Gii</a>
<a class="list-group-item" href="https://github.com/yiisoft/yii2-apidoc">Generating API Documentation</a></div>
<a class="list-group-item" href="#navigation-259" data-toggle="collapse" data-parent="#navigation">Testing <b class="caret"></b></a><div id="navigation-259" class="submenu panel-collapse collapse"><a class="list-group-item" href="./guide-test-overview.html">Overview</a>
<a class="list-group-item" href="./guide-test-environment-setup.html">Testing environment setup</a>
<a class="list-group-item" href="./guide-test-unit.html">Unit Tests</a>
<a class="list-group-item" href="./guide-test-functional.html">Functional Tests</a>
<a class="list-group-item" href="./guide-test-acceptance.html">Acceptance Tests</a>
<a class="list-group-item" href="./guide-test-fixtures.html">Fixtures</a></div>
<a class="list-group-item" href="#navigation-260" data-toggle="collapse" data-parent="#navigation">Special Topics <b class="caret"></b></a><div id="navigation-260" class="submenu panel-collapse collapse"><a class="list-group-item" href="https://github.com/yiisoft/yii2-app-advanced/blob/master/docs/guide/README.md">Advanced Project Template</a>
<a class="list-group-item" href="./guide-tutorial-start-from-scratch.html">Building Application from Scratch</a>
<a class="list-group-item" href="./guide-tutorial-console.html">Console Commands</a>
<a class="list-group-item" href="./guide-tutorial-core-validators.html">Core Validators</a>
<a class="list-group-item" href="./guide-tutorial-i18n.html">Internationalization</a>
<a class="list-group-item" href="./guide-tutorial-mailing.html">Mailing</a>
<a class="list-group-item" href="./guide-tutorial-performance-tuning.html">Performance Tuning</a>
<a class="list-group-item" href="./guide-tutorial-shared-hosting.html">Shared Hosting Environment</a>
<a class="list-group-item" href="./guide-tutorial-template-engines.html">Template Engines</a>
<a class="list-group-item" href="./guide-tutorial-yii-integration.html">Working with Third-Party Code</a></div>
<a class="list-group-item" href="#navigation-261" data-toggle="collapse" data-parent="#navigation">Widgets <b class="caret"></b></a><div id="navigation-261" class="submenu panel-collapse collapse"><a class="list-group-item" href="https://github.com/yiisoft/yii2-bootstrap/blob/master/docs/guide/README.md">Bootstrap Widgets</a>
<a class="list-group-item" href="https://github.com/yiisoft/yii2-jui/blob/master/docs/guide/README.md">jQuery UI Widgets</a></div>
<a class="list-group-item" href="#navigation-262" data-toggle="collapse" data-parent="#navigation">Helpers <b class="caret"></b></a><div id="navigation-262" class="submenu panel-collapse collapse"><a class="list-group-item" href="./guide-helper-overview.html">Overview</a>
<a class="list-group-item" href="./guide-helper-array.html">ArrayHelper</a>
<a class="list-group-item" href="./guide-helper-html.html">Html</a>
<a class="list-group-item" href="./guide-helper-url.html">Url</a></div></div>    </div>
    <div class="col-md-9 guide-content" role="main">
        <h1>The Definitive Guide to Yii 2.0 <span id="the-definitive-guide-to-yii-20"></span><a href="#the-definitive-guide-to-yii-20" class="hashlink">&para;</a></h1>
<div class="toc"><ol><li><a href="#introduction">Introduction</a></li>
<li><a href="#getting-started">Getting Started</a></li>
<li><a href="#application-structure">Application Structure</a></li>
<li><a href="#handling-requests">Handling Requests</a></li>
<li><a href="#key-concepts">Key Concepts</a></li>
<li><a href="#working-with-databases">Working with Databases</a></li>
<li><a href="#getting-data-from-users">Getting Data from Users</a></li>
<li><a href="#displaying-data">Displaying Data</a></li>
<li><a href="#security">Security</a></li>
<li><a href="#caching">Caching</a></li>
<li><a href="#restful-web-services">RESTful Web Services</a></li>
<li><a href="#development-tools">Development Tools</a></li>
<li><a href="#testing">Testing</a></li>
<li><a href="#special-topics">Special Topics</a></li>
<li><a href="#widgets">Widgets</a></li>
<li><a href="#helpers">Helpers</a></li></ol></div>
<p>This tutorial is released under the <a href="http://www.yiiframework.com/doc/terms/">Terms of Yii Documentation</a>.</p>
<p>All Rights Reserved.</p>
<p>2014 (c) Yii Software LLC.</p>
<h2>Introduction <span id="introduction"></span><a href="#introduction" class="hashlink">&para;</a></h2><ul>
<li><a href="guide-intro-yii.html">About Yii</a></li>
<li><a href="guide-intro-upgrade-from-v1.html">Upgrading from Version 1.1</a></li>
</ul>
<h2>Getting Started <span id="getting-started"></span><a href="#getting-started" class="hashlink">&para;</a></h2><ul>
<li><a href="guide-start-installation.html">Installing Yii</a></li>
<li><a href="guide-start-workflow.html">Running Applications</a></li>
<li><a href="guide-start-hello.html">Saying Hello</a></li>
<li><a href="guide-start-forms.html">Working with Forms</a></li>
<li><a href="guide-start-databases.html">Working with Databases</a></li>
<li><a href="guide-start-gii.html">Generating Code with Gii</a></li>
<li><a href="guide-start-looking-ahead.html">Looking Ahead</a></li>
</ul>
<h2>Application Structure <span id="application-structure"></span><a href="#application-structure" class="hashlink">&para;</a></h2><ul>
<li><a href="guide-structure-overview.html">Overview</a></li>
<li><a href="guide-structure-entry-scripts.html">Entry Scripts</a></li>
<li><a href="guide-structure-applications.html">Applications</a></li>
<li><a href="guide-structure-application-components.html">Application Components</a></li>
<li><a href="guide-structure-controllers.html">Controllers</a></li>
<li><a href="guide-structure-models.html">Models</a></li>
<li><a href="guide-structure-views.html">Views</a></li>
<li><a href="guide-structure-modules.html">Modules</a></li>
<li><a href="guide-structure-filters.html">Filters</a></li>
<li><a href="guide-structure-widgets.html">Widgets</a></li>
<li><a href="guide-structure-assets.html">Assets</a></li>
<li><a href="guide-structure-extensions.html">Extensions</a></li>
</ul>
<h2>Handling Requests <span id="handling-requests"></span><a href="#handling-requests" class="hashlink">&para;</a></h2><ul>
<li><a href="guide-runtime-overview.html">Overview</a></li>
<li><a href="guide-runtime-bootstrapping.html">Bootstrapping</a></li>
<li><a href="guide-runtime-routing.html">Routing and URL Creation</a></li>
<li><a href="guide-runtime-requests.html">Requests</a></li>
<li><a href="guide-runtime-responses.html">Responses</a></li>
<li><a href="guide-runtime-sessions-cookies.html">Sessions and Cookies</a></li>
<li><a href="guide-runtime-handling-errors.html">Handling Errors</a></li>
<li><a href="guide-runtime-logging.html">Logging</a></li>
</ul>
<h2>Key Concepts <span id="key-concepts"></span><a href="#key-concepts" class="hashlink">&para;</a></h2><ul>
<li><a href="guide-concept-components.html">Components</a></li>
<li><a href="guide-concept-properties.html">Properties</a></li>
<li><a href="guide-concept-events.html">Events</a></li>
<li><a href="guide-concept-behaviors.html">Behaviors</a></li>
<li><a href="guide-concept-configurations.html">Configurations</a></li>
<li><a href="guide-concept-aliases.html">Aliases</a></li>
<li><a href="guide-concept-autoloading.html">Class Autoloading</a></li>
<li><a href="guide-concept-service-locator.html">Service Locator</a></li>
<li><a href="guide-concept-di-container.html">Dependency Injection Container</a></li>
</ul>
<h2>Working with Databases <span id="working-with-databases"></span><a href="#working-with-databases" class="hashlink">&para;</a></h2><ul>
<li><a href="guide-db-dao.html">Data Access Objects</a>: Connecting to a database, basic queries, transactions, and schema manipulation</li>
<li><a href="guide-db-query-builder.html">Query Builder</a>: Querying the database using a simple abstraction layer</li>
<li><a href="guide-db-active-record.html">Active Record</a>: The Active Record ORM, retrieving and manipulating records, and defining relations</li>
<li><a href="guide-db-migrations.html">Migrations</a>: Apply version control to your databases in a team development environment</li>
<li><a href="https://github.com/yiisoft/yii2-sphinx/blob/master/docs/guide/README.md">Sphinx</a></li>
<li><a href="https://github.com/yiisoft/yii2-redis/blob/master/docs/guide/README.md">Redis</a></li>
<li><a href="https://github.com/yiisoft/yii2-mongodb/blob/master/docs/guide/README.md">MongoDB</a></li>
<li><a href="https://github.com/yiisoft/yii2-elasticsearch/blob/master/docs/guide/README.md">ElasticSearch</a></li>
</ul>
<h2>Getting Data from Users <span id="getting-data-from-users"></span><a href="#getting-data-from-users" class="hashlink">&para;</a></h2><ul>
<li><a href="guide-input-forms.html">Creating Forms</a></li>
<li><a href="guide-input-validation.html">Validating Input</a></li>
<li><a href="guide-input-file-upload.html">Uploading Files</a></li>
<li><a href="guide-input-tabular-input.html">Collecting Tabular Input</a></li>
<li><a href="guide-input-multiple-models.html">Getting Data for Multiple Models</a></li>
</ul>
<h2>Displaying Data <span id="displaying-data"></span><a href="#displaying-data" class="hashlink">&para;</a></h2><ul>
<li><a href="guide-output-formatting.html">Data Formatting</a></li>
<li><a href="guide-output-pagination.html">Pagination</a></li>
<li><a href="guide-output-sorting.html">Sorting</a></li>
<li><a href="guide-output-data-providers.html">Data Providers</a></li>
<li><a href="guide-output-data-widgets.html">Data Widgets</a></li>
<li><a href="guide-output-client-scripts.html">Working with Client Scripts</a></li>
<li><a href="guide-output-theming.html">Theming</a></li>
</ul>
<h2>Security <span id="security"></span><a href="#security" class="hashlink">&para;</a></h2><ul>
<li><a href="guide-security-overview.html">Overview</a></li>
<li><a href="guide-security-authentication.html">Authentication</a></li>
<li><a href="guide-security-authorization.html">Authorization</a></li>
<li><a href="guide-security-passwords.html">Working with Passwords</a></li>
<li><a href="guide-security-cryptography.html">Cryptography</a></li>
<li><a href="guide-structure-views.html#security">Views security</a></li>
<li><a href="https://github.com/yiisoft/yii2-authclient/blob/master/docs/guide/README.md">Auth Clients</a></li>
<li><a href="guide-security-best-practices.html">Best Practices</a></li>
</ul>
<h2>Caching <span id="caching"></span><a href="#caching" class="hashlink">&para;</a></h2><ul>
<li><a href="guide-caching-overview.html">Overview</a></li>
<li><a href="guide-caching-data.html">Data Caching</a></li>
<li><a href="guide-caching-fragment.html">Fragment Caching</a></li>
<li><a href="guide-caching-page.html">Page Caching</a></li>
<li><a href="guide-caching-http.html">HTTP Caching</a></li>
</ul>
<h2>RESTful Web Services <span id="restful-web-services"></span><a href="#restful-web-services" class="hashlink">&para;</a></h2><ul>
<li><a href="guide-rest-quick-start.html">Quick Start</a></li>
<li><a href="guide-rest-resources.html">Resources</a></li>
<li><a href="guide-rest-controllers.html">Controllers</a></li>
<li><a href="guide-rest-routing.html">Routing</a></li>
<li><a href="guide-rest-response-formatting.html">Response Formatting</a></li>
<li><a href="guide-rest-authentication.html">Authentication</a></li>
<li><a href="guide-rest-rate-limiting.html">Rate Limiting</a></li>
<li><a href="guide-rest-versioning.html">Versioning</a></li>
<li><a href="guide-rest-error-handling.html">Error Handling</a></li>
</ul>
<h2>Development Tools <span id="development-tools"></span><a href="#development-tools" class="hashlink">&para;</a></h2><ul>
<li><a href="https://github.com/yiisoft/yii2-debug/blob/master/docs/guide/README.md">Debug Toolbar and Debugger</a></li>
<li><a href="https://github.com/yiisoft/yii2-gii/blob/master/docs/guide/README.md">Generating Code using Gii</a></li>
<li><strong>TBD</strong> <a href="https://github.com/yiisoft/yii2-apidoc">Generating API Documentation</a></li>
</ul>
<h2>Testing <span id="testing"></span><a href="#testing" class="hashlink">&para;</a></h2><ul>
<li><a href="guide-test-overview.html">Overview</a></li>
<li><a href="guide-test-environment-setup.html">Testing environment setup</a></li>
<li><a href="guide-test-unit.html">Unit Tests</a></li>
<li><a href="guide-test-functional.html">Functional Tests</a></li>
<li><a href="guide-test-acceptance.html">Acceptance Tests</a></li>
<li><a href="guide-test-fixtures.html">Fixtures</a></li>
</ul>
<h2>Special Topics <span id="special-topics"></span><a href="#special-topics" class="hashlink">&para;</a></h2><ul>
<li><a href="https://github.com/yiisoft/yii2-app-advanced/blob/master/docs/guide/README.md">Advanced Project Template</a></li>
<li><a href="guide-tutorial-start-from-scratch.html">Building Application from Scratch</a></li>
<li><a href="guide-tutorial-console.html">Console Commands</a></li>
<li><a href="guide-tutorial-core-validators.html">Core Validators</a></li>
<li><a href="guide-tutorial-i18n.html">Internationalization</a></li>
<li><a href="guide-tutorial-mailing.html">Mailing</a></li>
<li><a href="guide-tutorial-performance-tuning.html">Performance Tuning</a></li>
<li><a href="guide-tutorial-shared-hosting.html">Shared Hosting Environment</a></li>
<li><a href="guide-tutorial-template-engines.html">Template Engines</a></li>
<li><a href="guide-tutorial-yii-integration.html">Working with Third-Party Code</a></li>
</ul>
<h2>Widgets <span id="widgets"></span><a href="#widgets" class="hashlink">&para;</a></h2><ul>
<li>GridView: <strong>TBD</strong> link to demo page</li>
<li>ListView: <strong>TBD</strong> link to demo page</li>
<li>DetailView: <strong>TBD</strong> link to demo page</li>
<li>ActiveForm: <strong>TBD</strong> link to demo page</li>
<li>Pjax: <strong>TBD</strong> link to demo page</li>
<li>Menu: <strong>TBD</strong> link to demo page</li>
<li>LinkPager: <strong>TBD</strong> link to demo page</li>
<li>LinkSorter: <strong>TBD</strong> link to demo page</li>
<li><a href="https://github.com/yiisoft/yii2-bootstrap/blob/master/docs/guide/README.md">Bootstrap Widgets</a></li>
<li><a href="https://github.com/yiisoft/yii2-jui/blob/master/docs/guide/README.md">jQuery UI Widgets</a></li>
</ul>
<h2>Helpers <span id="helpers"></span><a href="#helpers" class="hashlink">&para;</a></h2><ul>
<li><a href="guide-helper-overview.html">Overview</a></li>
<li><a href="guide-helper-array.html">ArrayHelper</a></li>
<li><a href="guide-helper-html.html">Html</a></li>
<li><a href="guide-helper-url.html">Url</a></li>
</ul>
        <div class="toplink"><a href="#" class="h1" title="go to top"><span class="glyphicon glyphicon-arrow-up"></a></div>
    </div>
</div>


</div>

<footer class="footer">
        <p class="pull-right"><small>Page generated on Sat, 09 Jul 2016 12:16:28 +0000</small></p>
    Powered by <a href="http://www.yiiframework.com/" rel="external">Yii Framework</a></footer>

<script type="text/javascript">jQuery(document).ready(function () {
    var shiftWindow = function () { scrollBy(0, -50) };
    if (location.hash) setTimeout(shiftWindow, 1);
    window.addEventListener("hashchange", shiftWindow);
var element = document.createElement("script");
element.src = "./jssearch.index.js";
document.body.appendChild(element);

var searchBox = $('#searchbox');

// search when typing in search field
searchBox.on("keyup", function(event) {
    var query = $(this).val();

    if (query == '' || event.which == 27) {
        $('#search-resultbox').hide();
        return;
    } else if (event.which == 13) {
        var selectedLink = $('#search-resultbox a.selected');
        if (selectedLink.length != 0) {
            document.location = selectedLink.attr('href');
            return;
        }
    } else if (event.which == 38 || event.which == 40) {
        $('#search-resultbox').show();

        var selected = $('#search-resultbox a.selected');
        if (selected.length == 0) {
            $('#search-results').find('a').first().addClass('selected');
        } else {
            var next;
            if (event.which == 40) {
                next = selected.parent().next().find('a').first();
            } else {
                next = selected.parent().prev().find('a').first();
            }
            if (next.length != 0) {
                var resultbox = $('#search-results');
                var position = next.position();

//              TODO scrolling is buggy and jumps around
//                resultbox.scrollTop(Math.floor(position.top));
//                console.log(position.top);

                selected.removeClass('selected');
                next.addClass('selected');
            }
        }

        return;
    }
    $('#search-resultbox').show();
    $('#search-results').html('<li><span class="no-results">No results</span></li>');

    var result = jssearch.search(query);

    if (result.length > 0) {
        var i = 0;
        var resHtml = '';

        for (var key in result) {
            if (i++ > 20) {
                break;
            }
            resHtml = resHtml +
            '<li><a href="' + result[key].file.u.substr(3) +'"><span class="title">' + result[key].file.t + '</span>' +
            '<span class="description">' + result[key].file.d + '</span></a></li>';
        }
        $('#search-results').html(resHtml);
    }
});

// hide the search results on ESC
$(document).on("keyup", function(event) { if (event.which == 27) { $('#search-resultbox').hide(); } });
// hide search results on click to document
$(document).bind('click', function (e) { $('#search-resultbox').hide(); });
// except the following:
searchBox.bind('click', function(e) { e.stopPropagation(); });
$('#search-resultbox').bind('click', function(e) { e.stopPropagation(); });

});</script></body>
</html>
